/**
 * # 参数列表实体类:
 *  DeleteAttachment - 删除附件
 * 
 * # 描述:
 *  删除通知中包含的附件文件。
 *  
 * Copyright (c), 上海沃恩信息科技有限公司.
 * All rights reserved.
 * Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

package com.waln.notifying.creating.args;

/**
 * 功能 删除附件 的参数列表。
 */
@pittypat.FunctionAnnotation(transaction = true)
public final class DeleteAttachment extends pittypat.FunctionArgs {
	/**
	 * 上传人的 Id。
	 * <p>
	 * 上传了当前附件文件的用户的 Id。
	 */
	@pittypat.ParameterAnnotation(position = 0, role = pittypat.ParameterRole.USER_ID)
	public java.util.UUID uploaderId;

	/**
	 * Id。
	 * <p>
	 * 附件文件的 Id。
	 */
	@pittypat.ParameterAnnotation(position = 1)
	public java.util.UUID id;

	/**
	 * 文件路径。
	 * <p>
	 * 附近文件的虚拟路径，用于删除物理文件。
	 */
	@pittypat.ParameterAnnotation(position = 2, direction = pittypat.ParameterDirection.OUT, maxLength = 300)
	public String url;

	/**
	 * 初始化 DeleteAttachment 类的一个新实例。
	 */
	public DeleteAttachment() {
		super();

		// 上传人的 Id
		this.uploaderId = null;
		// Id
		this.id = null;
		// 文件路径
		this.url = null;
	}

	/**
	 * 获取指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @return 指定名称的参数值。
	 */
	@Override
	public Object getParameterValue(String name) {
		if (name == null || name.length() == 0) {
			return null;
		}

		switch (name.toLowerCase()) {
			case "uploaderid":
				return this.uploaderId;
			case "id":
				return this.id;
			case "url":
				return this.url;
			default:
				return null;
		}
	}

	/**
	 * 设置指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @param value
	 * 			参数值。
	 * 
	 * @throws IllegalArgumentException
	 */
	@Override
	public void setParameterValue(String name, Object value) throws IllegalArgumentException {
		if (name == null || name.length() == 0) {
			throw new IllegalArgumentException("没有提供有效的参数名称。");
		}

		switch (name.toLowerCase()) {
			case "uploaderid":
				this.uploaderId = (java.util.UUID) value;
				break;
			case "id":
				this.id = (java.util.UUID) value;
				break;
			case "url":
				this.url = (String) value;
				break;
			default:
				throw new IllegalArgumentException(name + " 不是 " + this.getClass().getName() + " 的有效参数属性名称。");
		}
	}

	/**
	 * 将当前对象作为 JSON 字符串写入指定的文本流。
	 * 
	 * @param writer
	 * 			目标文本流。
	 * 
	 * @throws IllegalArgumentException
	 * @throws java.io.IOException
	 */
	@Override
	public void write(java.io.Writer writer) throws IllegalArgumentException, java.io.IOException {
		if (writer == null) {
			throw new IllegalArgumentException("writer 为 null。");
		}

		writer.write('{');

		// 上传人的 Id
		writer.write("\"uploaderId\":");
		pittypat.Json.write(writer, this.uploaderId);
		writer.write(',');

		// Id
		writer.write("\"id\":");
		pittypat.Json.write(writer, this.id);
		writer.write(',');

		// 文件路径
		writer.write("\"url\":");
		pittypat.Json.write(writer, this.url);

		writer.write('}');
	}
}
